 /******************************************************************************
 * @file     core_cmInstr.h
 * @brief    CMSIS Cortex-M Core Instruction Access Header File
 * @version  V3.01
 * @date     06. March 2012
 *
 * Copyright (C) 2009-2012 ARM Limited. All rights reserved.
 *
 * ARM Limited (ARM) is supplying this software for use with Cortex-M
 * processor based microcontrollers.  This file can be freely distributed
 * within development tools that are supporting such ARM based processors.
 *
 * THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED
 * OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
 * ARM SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR
 * CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 *
 ******************************************************************************/

#ifndef __CORE_CMINSTR_H
#  define __CORE_CMINSTR_H

/* ######################  Core Instruction Access  ######################### */
/*  No Operation

 */
__attribute__ ((always_inline)) static inline void __NOP(void)
{
  __ASM volatile ("nop");
}

/* Wait For Interrupt

    Wait For Interrupt is a hint instruction that suspends execution
    until one of a number of events occurs.
 */
__attribute__ ((always_inline)) static inline void __WFI(void)
{
  __ASM volatile ("wfi");
}

/* Wait For Event

    Wait For Event is a hint instruction that permits the processor to enter
    a low-power state until one of a number of events occurs.
 */
__attribute__ ((always_inline)) static inline void __WFE(void)
{
  __ASM volatile ("wfe");
}

/* Send Event

    Send Event is a hint instruction. It causes an event to be signaled to the
    CPU.
 */
__attribute__ ((always_inline)) static inline void __SEV(void)
{
  __ASM volatile ("sev");
}

/* Instruction Synchronization Barrier

    Instruction Synchronization Barrier flushes the pipeline in the processor,
    so that all instructions following the ISB are fetched from cache or
    memory, after the instruction has been completed.
 */
__attribute__ ((always_inline)) static inline void __ISB(void)
{
  __ASM volatile ("isb");
}


/* Data Synchronization Barrier

    This function acts as a special kind of Data Memory Barrier.  It completes
    when all explicit memory accesses before this instruction complete.
 */
__attribute__ ((always_inline)) static inline void __DSB(void)
{
  __ASM volatile ("dsb");
}


/* Data Memory Barrier

    This function ensures the apparent order of the explicit memory operations
    before and after the instruction, without ensuring their completion.
 */
__attribute__ ((always_inline)) static inline void __DMB(void)
{
  __ASM volatile ("dmb");
}


/* Reverse byte order (32 bit)

    This function reverses the byte order in integer value.

    \param [in]    value  Value to reverse
    \return               Reversed value
 */
__attribute__ ((always_inline)) static inline uint32_t __REV(uint32_t value)
{
  uint32_t result;

  __ASM volatile ("rev %0, %1":"=r" (result):"r"(value));
  return (result);
}


/* Reverse byte order (16 bit)

    This function reverses the byte order in two unsigned short values.

    \param [in]    value  Value to reverse
    \return               Reversed value
 */
__attribute__ ((always_inline)) static inline uint32_t __REV16(uint32_t value)
{
  uint32_t result;

  __ASM volatile ("rev16 %0, %1":"=r" (result):"r"(value));
  return (result);
}


/* Reverse byte order in signed short value

    This function reverses the byte order in a signed short value with sign
    extension to integer.

    \param [in]    value  Value to reverse
    \return               Reversed value
 */
__attribute__ ((always_inline)) static inline int32_t __REVSH(int32_t value)
{
  uint32_t result;

  __ASM volatile ("revsh %0, %1":"=r" (result):"r"(value));
  return (result);
}


/* Rotate Right in unsigned value (32 bit)

    This function Rotate Right (immediate) provides the value of the contents
    of a register rotated by a variable number of bits.

    \param [in]    value  Value to rotate
    \param [in]    value  Number of Bits to rotate
    \return               Rotated value
 */
__attribute__ ((always_inline)) static inline uint32_t __ROR(uint32_t op1, uint32_t op2)
{

  __ASM volatile ("ror %0, %0, %1":"+r" (op1):"r"(op2));
  return (op1);
}


#  if       (__CORTEX_M >= 0x03)

/* Reverse bit order of value

    This function reverses the bit order of the given value.

    \param [in]    value  Value to reverse
    \return               Reversed value
 */
__attribute__ ((always_inline)) static inline uint32_t __RBIT(uint32_t value)
{
  uint32_t result;

  __ASM volatile ("rbit %0, %1":"=r" (result):"r"(value));
  return (result);
}


/* LDR Exclusive (8 bit)

    This function performs a exclusive LDR command for 8 bit value.

    \param [in]    ptr  Pointer to data
    \return             value of type uint8_t at (*ptr)
 */
__attribute__ ((always_inline)) static inline uint8_t __LDREXB(volatile uint8_t * addr)
{
  uint8_t result;

  __ASM volatile ("ldrexb %0, [%1]":"=r" (result):"r"(addr));
  return (result);
}


/* LDR Exclusive (16 bit)

    This function performs a exclusive LDR command for 16 bit values.

    \param [in]    ptr  Pointer to data
    \return        value of type uint16_t at (*ptr)
 */
__attribute__ ((always_inline)) static inline uint16_t __LDREXH(volatile uint16_t * addr)
{
  uint16_t result;

  __ASM volatile ("ldrexh %0, [%1]":"=r" (result):"r"(addr));
  return (result);
}


/* LDR Exclusive (32 bit)

    This function performs a exclusive LDR command for 32 bit values.

    \param [in]    ptr  Pointer to data
    \return        value of type uint32_t at (*ptr)
 */
__attribute__ ((always_inline)) static inline uint32_t __LDREXW(volatile uint32_t * addr)
{
  uint32_t result;

  __ASM volatile ("ldrex %0, [%1]":"=r" (result):"r"(addr));
  return (result);
}


/* STR Exclusive (8 bit)

    This function performs a exclusive STR command for 8 bit values.

    \param [in]  value  Value to store
    \param [in]    ptr  Pointer to location
    \return          0  Function succeeded
    \return          1  Function failed
 */
__attribute__ ((always_inline)) static inline uint32_t __STREXB(uint8_t value, volatile uint8_t * addr)
{
  uint32_t result;

  __ASM volatile ("strexb %0, %2, [%1]":"=&r" (result):"r"(addr), "r"(value));
  return (result);
}


/* STR Exclusive (16 bit)

    This function performs a exclusive STR command for 16 bit values.

    \param [in]  value  Value to store
    \param [in]    ptr  Pointer to location
    \return          0  Function succeeded
    \return          1  Function failed
 */
__attribute__ ((always_inline)) static inline uint32_t __STREXH(uint16_t value, volatile uint16_t * addr)
{
  uint32_t result;

  __ASM volatile ("strexh %0, %2, [%1]":"=&r" (result):"r"(addr), "r"(value));
  return (result);
}


/* STR Exclusive (32 bit)

    This function performs a exclusive STR command for 32 bit values.

    \param [in]  value  Value to store
    \param [in]    ptr  Pointer to location
    \return          0  Function succeeded
    \return          1  Function failed
 */
__attribute__ ((always_inline)) static inline uint32_t __STREXW(uint32_t value, volatile uint32_t * addr)
{
  uint32_t result;

  __ASM volatile ("strex %0, %2, [%1]":"=&r" (result):"r"(addr), "r"(value));
  return (result);
}


/* Remove the exclusive lock

    This function removes the exclusive lock which is created by LDREX.

 */
__attribute__ ((always_inline)) static inline void __CLREX(void)
{
  __ASM volatile ("clrex");
}


/* Signed Saturate

    This function saturates a signed value.

    \param [in]  value  Value to be saturated
    \param [in]    sat  Bit position to saturate to (1..32)
    \return             Saturated value
 */
#    define __SSAT(ARG1,ARG2) \
({                          \
  uint32_t __RES, __ARG1 = (ARG1); \
  __ASM ("ssat %0, %1, %2" : "=r" (__RES) :  "I" (ARG2), "r" (__ARG1) ); \
  __RES; \
 })


/* Unsigned Saturate

    This function saturates an unsigned value.

    \param [in]  value  Value to be saturated
    \param [in]    sat  Bit position to saturate to (0..31)
    \return             Saturated value
 */
#    define __USAT(ARG1,ARG2) \
({                          \
  uint32_t __RES, __ARG1 = (ARG1); \
  __ASM ("usat %0, %1, %2" : "=r" (__RES) :  "I" (ARG2), "r" (__ARG1) ); \
  __RES; \
 })


/* Count leading zeros

    \param [in]  value  Value to count the leading zeros
    \return             number of leading zeros in value
 */
__attribute__ ((always_inline)) static inline uint8_t __CLZ(uint32_t value)
{
  uint8_t result;

  __ASM volatile ("clz %0, %1":"=r" (result):"r"(value));
  return (result);
}

#  endif                        /* (__CORTEX_M >= 0x03) */
#endif                          /* __CORE_CMINSTR_H */
